Skip to content

Conversation

@constanca-m
Copy link
Contributor

@constanca-m constanca-m commented Dec 1, 2025

This PR is far from finished, I am only opening it to share the current status.

I have added the structure and some documentation. It still needs a few things that I have left commented in the document.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

Vale Linting Results

Summary: 14 suggestions found

💡 Suggestions (14)
File Line Rule Message
docs/reference/edot-cloud-forwarder/gcp.md 30 Elastic.Acronyms 'GCS' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 33 Elastic.Acronyms 'GCS' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 42 Elastic.Acronyms 'VPC' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 67 Elastic.Acronyms 'IAM' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 68 Elastic.Acronyms 'IAM' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 151 Elastic.Ellipses In general, don't use an ellipsis.
docs/reference/edot-cloud-forwarder/gcp.md 167 Elastic.Acronyms 'GCS' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 167 Elastic.Acronyms 'VPC' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 174 Elastic.Acronyms 'GCS' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 182 Elastic.Acronyms 'GCS' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 192 Elastic.FutureTense 'will still' might be in future tense. Write in the present tense to describe the state of the product as it is now.
docs/reference/edot-cloud-forwarder/gcp.md 192 Elastic.Acronyms 'GCS' has no definition.
docs/reference/edot-cloud-forwarder/gcp.md 192 Elastic.FutureTense 'going to succeed' might be in future tense. Write in the present tense to describe the state of the product as it is now.
docs/reference/edot-cloud-forwarder/index.md 29 Elastic.Acronyms 'GCS' has no definition.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

@constanca-m
Copy link
Contributor Author

I am going to open this PR for review. There is one critical section still missing: the quick start. I can't write on it yet. You can see the tracking issue: https://elasticco.atlassian.net/browse/ENGPRD-1866. Every other section is ready to be reviewed. Maybe I will come back to add the Performance section again, but for now, it is skipped (it wasn't a requirement for tech preview, anyway).

@constanca-m constanca-m marked this pull request as ready for review December 3, 2025 12:29
@constanca-m constanca-m requested a review from a team as a code owner December 3, 2025 12:29
Copy link
Collaborator

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First review pass. Very clever usage of the dropdowns!

Some comments/questions:

  • What are the deployment methods for this? How is EDOT CF installed and removed?
  • Depending on the above, what resources are created? Might be useful to have a list similar to this.

deployment:
ess: preview
product:
edot_cf_gcp: preview
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This product doesn't exist yet but will be added in elastic/docs-builder#2303

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I had noticed

@constanca-m
Copy link
Contributor Author

What are the deployment methods for this? How is EDOT CF installed and removed?

This is the missing Quick start section. It will be a Terraform module published in the registry. Since we need a README in the Terraform module, I think this documentation will only point to it, so we don't have to maintain two pages saying the exact same thing. I am waiting on https://elasticco.atlassian.net/browse/ENGPRD-1866 for this.

@theletterf
Copy link
Collaborator

@constanca-m Thanks! Let's follow up once the TF ReadMe is up, we might still want to wrap it in some pre- and post- steps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants